HuasoFoundries / backgrid_es6

  backgrid

  http://github.com/wyuenho/backgrid

  Copyright (c) 2013-present Cloudflare, Inc and contributors

  Licensed under the MIT @license.

*/

describe("A PageHandle", function () {

  var collection;

  beforeEach(function () {

    collection = new Backbone.PageableCollection([{

      id: 1

    }, {

      id: 2

    }, {

      id: 3

    }, {

      id: 4

    }, {

      id: 5

    }], {

      state: {

        pageSize: 2

      },

      mode: "client"

    });

  });

  describe("when under discrete mode", function () {

    it("renders a 1-based label based on a 0-based pageIndex", function () {

      var handle = new Backgrid.Extension.PageHandle({

        collection: collection,

        pageIndex: 0

      });

      handle.render();

      expect(handle.$("a").text()).toBe("1");

    });

    it("renders a label independently of the pageIndex if one is given", function () {

      var handle = new Backgrid.Extension.PageHandle({

        collection: collection,

        pageIndex: 0,

        label: "a"

      });

      handle.render();

      expect(handle.$("a").text()).toBe("a");

    });

    it("renders a default title", function () {

      var handle = new Backgrid.Extension.PageHandle({

        collection: collection,

        pageIndex: 0

      });

      handle.render();

      expect(handle.$("a").attr("title")).toBe("Page 1");

    });

    it("renders the title if one is given", function () {

      var handle = new Backgrid.Extension.PageHandle({

        collection: collection,

        pageIndex: 0,

        title: "one"

      });

      handle.render();

      expect(handle.$("a").attr("title")).toBe("one");

    });

    it("renders a title template if one is given", function () {

      var handle = new Backgrid.Extension.PageHandle({

        collection: collection,

        pageIndex: 0,

        title: _.template("No. <%- label %>")

      });

      handle.render();

      expect(handle.$("a").attr("title")).toBe("No. 1");

    });

    it("renders an active page handle if current page = pageIndex", function () {

      var handle = new Backgrid.Extension.PageHandle({

        collection: collection,

        pageIndex: 0

      });

      handle.render();

      expect(handle.$el.hasClass("active")).toBe(true);

      expect(handle.$("a").attr("title")).toBe("Page 1");

      expect(handle.$("a").text()).toBe("1");

    });

    it("renders an page handle if current page != pageIndex", function () {

      var handle = new Backgrid.Extension.PageHandle({

        collection: collection,

        pageIndex: 1

      });

      handle.render();

      expect(handle.$el.hasClass("active")).toBe(false);

      expect(handle.$("a").attr("title")).toBe("Page 2");

      expect(handle.$("a").text()).toBe("2");

    });

    it("the handle will get the page on click", function () {

      var handle = new Backgrid.Extension.PageHandle({

        collection: collection,

        pageIndex: 1

      });

      handle.render();

      handle.$("a").click();

      expect(collection.state.currentPage).toBe(2);

    });

  });

});

describe("A Paginator", function () {

  var collection, paginator;

  it("can override default settings by passing options to the constructor", function () {

    paginator = new Backgrid.Extension.Paginator({

      collection: new Backbone.Collection(),

      windowSize: 1,

      slideScale: 1,

      renderIndexedPageHandles: false,

      pageHandle: Backgrid.Extension.PageHandle.extend({}),

      goBackFirstOnSort: false

    });

    expect(paginator.windowSize).not.toBe(Backgrid.Extension.Paginator.prototype.windowSize);

    expect(paginator.slideScale).not.toBe(Backgrid.Extension.Paginator.prototype.slideScale);

    expect(paginator.renderIndexedPageHandles).not.toBe(Backgrid.Extension.Paginator.prototype.renderIndexedPageHandles);

    expect(paginator.pageHandle).not.toBe(Backgrid.Extension.Paginator.prototype.pageHandle);

    expect(paginator.goBackFirstOnSort).not.toBe(Backgrid.Extension.Paginator.prototype.goBackFirstOnSort);

  });

  describe("when under client mode", function () {

    beforeEach(function () {

      collection = new Backbone.PageableCollection([{

        id: 1

      }, {

        id: 2

      }, {

        id: 3

      }, {

        id: 4

      }, {

        id: 5

      }], {

        state: {

          pageSize: 2

        },

        mode: "client"

      });

      paginator = new Backgrid.Extension.Paginator({

        collection: collection,

      });

      paginator.render();

    });

    it("#calculateWindow should return the correct start and end bound", function () {

      var window = paginator._calculateWindow();

      expect(window[0]).toBe(0);

      expect(window[1]).toBe(3);

      collection.fullCollection.pop();

      var window = paginator._calculateWindow();

      expect(window[0]).toBe(0);

      expect(window[1]).toBe(2);

      collection.fullCollection.pop();

      var window = paginator._calculateWindow();

      expect(window[0]).toBe(0);

      expect(window[1]).toBe(2);

      collection.fullCollection.shift();

      var window = paginator._calculateWindow();

      expect(window[0]).toBe(0);

      expect(window[1]).toBe(1);

      collection.fullCollection.reset();

      var window = paginator._calculateWindow();

      expect(window[0]).toBe(0);

      expect(window[1]).toBe(1);

    });

    it("renders 1 handle when the collection has <= 1 page", function () {

      paginator = new Backgrid.Extension.Paginator({

        collection: new Backbone.PageableCollection([], {

          state: {

            pageSize: 2

          },

          mode: "client"

        })

      });

      paginator.render();

      expect(paginator.$el.find("a").length).toBe(5);

      expect(paginator.$el.find("a[title='Page 1']").length).toBe(1);

      expect(paginator.$el.find("a[title='Page 2']").length).toBe(0);

      paginator = new Backgrid.Extension.Paginator({

        collection: new Backbone.PageableCollection([{

          id: 1

        }], {

          state: {

            pageSize: 2

          },

          mode: "client"

        })

      });

      paginator.render();

      expect(paginator.$el.find("a").length).toBe(5);

      expect(paginator.$el.find("a[title='Page 1']").length).toBe(1);

      expect(paginator.$el.find("a[title='Page 2']").length).toBe(0);

      paginator = new Backgrid.Extension.Paginator({

        collection: new Backbone.PageableCollection([{

          id: 1

        }, {

          id: 2

        }], {

          state: {

            pageSize: 2

          },

          mode: "client"

        })

      });

      paginator.render();

      expect(paginator.$el.find("a").length).toBe(5);

      expect(paginator.$el.find("a[title='Page 1']").length).toBe(1);

      expect(paginator.$el.find("a[title='Page 2']").length).toBe(0);

    });

    it("clicking on active or disabled page handles have no effect", function () {

      paginator = new Backgrid.Extension.Paginator({

        collection: new Backbone.PageableCollection([{

          id: 1

        }], {

          state: {

            pageSize: 1

          },

          mode: "client"

        })

      });

      paginator.$el.find("a").eq(0).click();

      expect(paginator.collection.state.currentPage).toBe(1);

      paginator.$el.find("a").eq(1).click();

      expect(paginator.collection.state.currentPage).toBe(1);

      paginator.$el.find("a").eq(2).click();

      expect(paginator.collection.state.currentPage).toBe(1);

      paginator.$el.find("a").eq(3).click();

      expect(paginator.collection.state.currentPage).toBe(1);

      paginator.$el.find("a").eq(4).click();

      expect(paginator.collection.state.currentPage).toBe(1);

    });

    it("has page handles that go to the correct pages when clicked", function () {

      // page 2

      paginator.$el.find("a").eq(3).click();

      expect(collection.state.currentPage).toBe(2);

      // page 1

      paginator.$el.find("a").eq(2).click();

      expect(collection.state.currentPage).toBe(1);

      // reset window size and rerender

      paginator.windowSize = 1;

      paginator.render();

      // last page

      paginator.$el.find("a").eq(4).click();

      expect(paginator.$el.find("a").eq(2).html()).toBe('3');

      expect(collection.state.currentPage).toBe(3);

      // prev page

      paginator.$el.find("a").eq(1).click();

      expect(paginator.$el.find("a").eq(2).html()).toBe('2');

      expect(collection.state.currentPage).toBe(2);

      // 0-based page indices

      collection = new Backbone.PageableCollection([{

        id: 1

      }, {

        id: 2

      }, {

        id: 3

      }], {

        mode: "client",

        state: {

          pageSize: 1,

          firstPage: 0

        }

      });

      paginator = new Backgrid.Extension.Paginator({

        collection: collection,

      });

      paginator.render();

      // next page

      paginator.$el.find("a").eq(3).click();

      expect(collection.state.currentPage).toBe(1);

      // first page

      paginator.$el.find("a").eq(0).click();

      expect(collection.state.currentPage).toBe(0);

    });

    it("renders page handles <= windowSize", function () {

      expect(paginator.$el.find("a").length).toBe(7);

      paginator.windowSize = 1;

      paginator.render();

      expect(paginator.$el.find("a").length).toBe(5);

    });

    it("refreshes upon row insertion", function () {

      collection.add([{

        id: 6

      }, {

        id: 7

      }]);

      expect(paginator.$el.find("a").length).toBe(8);

      expect(paginator.$el.find("a[title='Page 4']").length).toBe(1);

    });

    it("refreshes upon row removal", function () {

      collection.remove(collection.first());

      expect(paginator.$el.find("a").length).toBe(6);

      expect(paginator.$el.find("a[title='Page 3']").length).toBe(0);

    });

    it("refreshes upon collection reset", function () {

      collection.fullCollection.reset();

      expect(paginator.$el.find("a").length).toBe(5);

      expect(paginator.$el.find("a[title='Page 1']").length).toBe(1);

      expect(paginator.$el.find("a[title='Page 2']").length).toBe(0);

    });

    it("will go back to the first page on sort by default", function () {

      paginator.$el.find("a").eq(3).click();

      collection.setSorting("id", -1);

      collection.fullCollection.sort();

      collection.trigger("backgrid:sorted");

      expect(paginator.$el.find("li").eq(2).hasClass("active")).toBe(true);

      paginator.goBackFirstOnSort = false;

      paginator.$el.find("a").eq(3).click();

      collection.fullCollection.sort();

      collection.trigger("backgrid:sorted");

      expect(paginator.$el.find("li").eq(3).hasClass("active")).toBe(true);

    });

    it("displays a single page handler number 1 when the collection is empty and totalRecords is null", function () {

      paginator = new Backgrid.Extension.Paginator({

        collection: new(Backbone.PageableCollection.extend({

          mode: "client"

        }))()

      });

      paginator.render();

      expect(paginator.$el.find("a").length).toBe(5);

      expect(paginator.$el.find("a[title='Page 1']").length).toBe(1);

      expect(paginator.$el.find("a[title='Page 2']").length).toBe(0);

    });

    it("renders the overriden control page handle labels and titles", function () {

      paginator = new(Backgrid.Extension.Paginator.extend({

        controls: {

          back: {

            label: "prev",

            title: "prev"

          },

          forward: {

            label: "next",

            title: "next"

          }

        }

      }))({

        collection: collection

      });

      paginator.render();

      expect(paginator.$el.find("a").length).toBe(7);

      expect(paginator.$el.find("a").eq(1).html()).toBe("prev");

      expect(paginator.$el.find("a").eq(5).html()).toBe("next");

    });

    it("renders no indexed handles if renderIndexedPageHandles is false", function () {

      paginator = new Backgrid.Extension.Paginator({

        collection: collection,

        renderIndexedPageHandles: false

      });

      paginator.render();

      expect(paginator.$el.find("a").length).toBe(4);

      expect(paginator.$el.find("a").eq(0).attr("title")).toBe("First");

      expect(paginator.$el.find("a").eq(1).attr("title")).toBe("Previous");

      expect(paginator.$el.find("a").eq(2).attr("title")).toBe("Next");

      expect(paginator.$el.find("a").eq(3).attr("title")).toBe("Last");

    });

  });

  describe("when under server mode", function () {

    beforeEach(function () {

      collection = new Backbone.PageableCollection([{

        id: 1

      }], {

        state: {

          pageSize: 1,

          totalRecords: 3

        }

      });

      paginator = new Backgrid.Extension.Paginator({

        collection: collection

      });

      paginator.render();

    });

    it("clicking on active or disabled page handles have no effect", function () {

      paginator = new Backgrid.Extension.Paginator({

        collection: new Backbone.PageableCollection([{

          id: 1

        }], {

          state: {

            pageSize: 1

          }

        })

      });

      paginator.$el.find("a").eq(0).click();

      expect(paginator.collection.state.currentPage).toBe(1);

      paginator.$el.find("a").eq(1).click();

      expect(paginator.collection.state.currentPage).toBe(1);

      paginator.$el.find("a").eq(2).click();

      expect(paginator.collection.state.currentPage).toBe(1);

      paginator.$el.find("a").eq(3).click();

      expect(paginator.collection.state.currentPage).toBe(1);

      paginator.$el.find("a").eq(4).click();

      expect(paginator.collection.state.currentPage).toBe(1);

    });

    it("has page handles that go to the correct pages when clicked", function () {

      paginator.windowSize = 1;

      paginator.render();

      collection.url = "url";

      var oldAjax = Backbone.ajax;

      // last page

      Backbone.ajax = function (settings) {

        settings.success([{

          id: 3

        }]);

      };

      paginator.$el.find("a").eq(4).click();

      expect(paginator.$el.find("a").eq(2).html()).toBe('3');

      expect(collection.state.currentPage).toBe(3);

      // prev page

      Backbone.ajax = function (settings) {

        settings.success([{

          id: 2

        }]);

      };

      paginator.$el.find("a").eq(1).click();

      expect(paginator.$el.find("a").eq(2).html()).toBe('2');

      expect(collection.state.currentPage).toBe(2);

      // 0-based page indices

      collection = new Backbone.PageableCollection([{

        id: 1

      }, {

        id: 2

      }], {

        state: {

          pageSize: 2,

          totalRecords: 5,

          firstPage: 0

        }

      });

      collection.url = "url";

      paginator = new Backgrid.Extension.Paginator({

        collection: collection

      });

      paginator.render();

      // page 2

      Backbone.ajax = function (settings) {

        settings.success([{

          id: 3

        }, {

          id: 4

        }]);

      };

      paginator.$el.find("a").eq(3).click();

      expect(collection.state.currentPage).toBe(1);

      // page 1

      Backbone.ajax = function (settings) {

        settings.success([{

          id: 1

        }, {

          id: 2

        }]);

      };

      paginator.$el.find("a").eq(2).click();

      expect(collection.state.currentPage).toBe(0);

      // next page

      Backbone.ajax = function (settings) {

        settings.success([{

          id: 3

        }, {

          id: 4

        }]);

      };

      paginator.$el.find("a").eq(5).click();

      expect(collection.state.currentPage).toBe(1);

      // first page

      Backbone.ajax = function (settings) {

        settings.success([{

          id: 1

        }, {

          id: 2

        }]);

      };

      paginator.$el.find("a").eq(0).click();

      expect(collection.state.currentPage).toBe(0);

      Backbone.ajax = oldAjax;

    });

    it("renders page handles <= windowSize", function () {

      expect(paginator.$el.find("a").length).toBe(7);

      paginator.windowSize = 1;

      paginator.render();

      expect(paginator.$el.find("a").length).toBe(5);

    });

    it("displays a single page handler number 1 when the collection is empty and totalRecords is null", function () {

      paginator = new Backgrid.Extension.Paginator({

        collection: new Backbone.PageableCollection()

      });

      paginator.render();

      expect(paginator.$el.find("a").length).toBe(5);

      expect(paginator.$el.find("a[title='Page 1']").length).toBe(1);

      expect(paginator.$el.find("a[title='Page 2']").length).toBe(0);

    });

    it("refreshes upon collection reset", function () {

      collection.reset([{

        id: 1

      }]);

      expect(paginator.$el.find("a").length).toBe(7);

      expect(paginator.$el.find("a[title='Page 1']").length).toBe(1);

      expect(paginator.$el.find("a[title='Page 2']").length).toBe(1);

      expect(paginator.$el.find("a[title='Page 3']").length).toBe(1);

    });

    it("renders the overriden control page handle labels and titles", function () {

      paginator = new(Backgrid.Extension.Paginator.extend({

        controls: {

          back: {

            label: "prev",

            title: "prev"

          },

          forward: {

            label: "next",

            title: "next"

          }

        }

      }))({

        collection: collection

      });

      paginator.render();

      expect(paginator.$el.find("a").length).toBe(7);

      expect(paginator.$el.find("a").eq(1).html()).toBe("prev");

      expect(paginator.$el.find("a").eq(5).html()).toBe("next");

    });

    it("renders no indexed handles if renderIndexedPageHandles is false", function () {

      paginator = new Backgrid.Extension.Paginator({

        collection: collection,

        renderIndexedPageHandles: false

      });

      paginator.render();

      expect(paginator.$el.find("a").length).toBe(4);

      expect(paginator.$el.find("a").eq(0).attr("title")).toBe("First");

      expect(paginator.$el.find("a").eq(1).attr("title")).toBe("Previous");

      expect(paginator.$el.find("a").eq(2).attr("title")).toBe("Next");

      expect(paginator.$el.find("a").eq(3).attr("title")).toBe("Last");

    });

    it("does not refetch if already on first page when sorting", function () {

      spyOn(collection, "getFirstPage").and.stub();

      collection.trigger("backgrid:sorted");

      expect(collection.getFirstPage.calls.count()).toEqual(0);

    });

  });

  describe("when under infinite mode", function () {

    beforeEach(function () {

      collection = new(Backbone.PageableCollection.extend({

        url: "http://www.example.com",

      }))([{

        id: 1

      }, {

        id: 2

      }, {

        id: 3

      }, {

        id: 4

      }, {

        id: 5

      }], {

        state: {

          pageSize: 2,

          totalRecords: 5

        },

        mode: "infinite"

      });

      paginator = new Backgrid.Extension.Paginator({

        collection: collection

      });

      paginator.render();

    });

    it("renders the overriden control page handle labels and titles", function () {

      paginator = new(Backgrid.Extension.Paginator.extend({

        controls: {

          back: {

            label: "prev",

            title: "prev"

          },

          forward: {

            label: "next",

            title: "next"

          }

        }

      }))({

        collection: collection

      });

      paginator.render();

      expect(paginator.$el.find("a").length).toBe(7);

      expect(paginator.$el.find("a").eq(1).html()).toBe("prev");

      expect(paginator.$el.find("a").eq(5).html()).toBe("next");

    });

    it("renders no indexed handles if renderIndexedPageHandles is false", function () {

      paginator = new Backgrid.Extension.Paginator({

        collection: collection,

        renderIndexedPageHandles: false

      });

      paginator.render();

      expect(paginator.$el.find("a").length).toBe(4);

      expect(paginator.$el.find("a").eq(0).attr("title")).toBe("First");

      expect(paginator.$el.find("a").eq(1).attr("title")).toBe("Previous");

      expect(paginator.$el.find("a").eq(2).attr("title")).toBe("Next");

      expect(paginator.$el.find("a").eq(3).attr("title")).toBe("Last");

    });

  });

  describe("hiding paginator when <= 1 total pages", function () {

    it("renders 0 handles when the collection has 1 page", function () {

      paginator = new Backgrid.Extension.Paginator({

        collection: new Backbone.PageableCollection([], {

          state: {

            pageSize: 2

          },

          mode: "client"

        }),

        renderMultiplePagesOnly: true

      });

      paginator.render();

      expect(paginator.$el.find("a").length).toBe(0);

      paginator = new Backgrid.Extension.Paginator({

        collection: new Backbone.PageableCollection([{

          id: 1

        }], {

          state: {

            pageSize: 2

          },

          mode: "client"

        }),

        renderMultiplePagesOnly: true

      });

      paginator.render();

      expect(paginator.$el.find("a").length).toBe(0);

      paginator = new Backgrid.Extension.Paginator({

        collection: new Backbone.PageableCollection([{

          id: 1

        }, {

          id: 2

        }], {

          state: {

            pageSize: 2

          },

          mode: "client"

        }),

        renderMultiplePagesOnly: true

      });

      paginator.render();

      expect(paginator.$el.find("a").length).toBe(0);

      paginator = new Backgrid.Extension.Paginator({

        collection: new Backbone.PageableCollection([{

          id: 1

        }, {

          id: 2

        }, {

          id: 3

        }], {

          state: {

            pageSize: 2

          },

          mode: "client"

        }),

        renderMultiplePagesOnly: true

      });

      paginator.render();

      expect(paginator.$el.find("a").length).toBe(6);

      expect(paginator.$el.find("a[title='Page 1']").length).toBe(1);

      expect(paginator.$el.find("a[title='Page 2']").length).toBe(1);

    });

  });

});